Active Users API

POST /activeUsers

Description

This API endpoint retrieves a paginated list of active users.

Request Body

The request uses GraphQL to perform the activeUsers query.

Query:

query activeUsers ($page: Int, $size: Int) {
    activeUsers (page: $page, size: $size) {
        totalElements
        size
        number
    }
}

GraphQL Variables:

{
  "page": 0,
  "size": 0
}

Example Request:

curl --location '' \
--header 'Content-Type: application/json' \
--data '{"query":"query activeUsers ($page: Int, $size: Int) {\n    activeUsers (page: $page, size: $size) {\n        totalElements\n        size\n        number\n    }\n}","variables":{"page":0,"size":0}}'

Response:

• Success (200 OK):

  • The response includes pagination details for active users.

  {
    "data": {
      "activeUsers": {
        "totalElements": 1500,
        "size": 10,
        "number": 1
      }
    }
  }
  • totalElements: Total number of active users.
  • size: Number of active users per page.
  • number: Current page number.

• Error (4XX/5XX):

  • If there is an issue with the request or if there is a server error, the response will include an error message and status code.

Note:

This endpoint provides paginated data on active users, useful for applications requiring detailed user activity analysis and management. Adjust the page and size parameters to navigate through the results.